<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: com.amazon.aace.navigation.Navigation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Alexa Auto SDK
   &#160;<span id="projectnumber">2.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>com</b></li><li class="navelem"><b>amazon</b></li><li class="navelem"><b>aace</b></li><li class="navelem"><b>navigation</b></li><li class="navelem"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html">Navigation</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">com.amazon.aace.navigation.Navigation Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab8bfcea62eb634ece636a1264b5b5a89"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#ab8bfcea62eb634ece636a1264b5b5a89">cancelNavigation</a> ()</td></tr>
<tr class="separator:ab8bfcea62eb634ece636a1264b5b5a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c911a083f6b927749106f3e3763dde"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#ab9c911a083f6b927749106f3e3763dde">getNavigationState</a> ()</td></tr>
<tr class="separator:ab9c911a083f6b927749106f3e3763dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93fd177c707c9075348883824c7dcc0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#a93fd177c707c9075348883824c7dcc0b">startNavigation</a> (String payload)</td></tr>
<tr class="separator:a93fd177c707c9075348883824c7dcc0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9c67468d2301d910b4ae765f60f34d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aa9c67468d2301d910b4ae765f60f34d5">announceManeuver</a> (String payload)</td></tr>
<tr class="separator:aa9c67468d2301d910b4ae765f60f34d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee853c3f66d8205e733fb27644b829f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aee853c3f66d8205e733fb27644b829f1">announceRoadRegulation</a> (RoadRegulation roadRegulation)</td></tr>
<tr class="separator:aee853c3f66d8205e733fb27644b829f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af554852edcf3c872474896fef22a6403"><td class="memItemLeft" align="right" valign="top">final void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#af554852edcf3c872474896fef22a6403">navigationError</a> (ErrorType type, ErrorCode code, String description)</td></tr>
<tr class="separator:af554852edcf3c872474896fef22a6403"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6920b2f0e9a84e290c16acac2f86ae93"><td class="memItemLeft" align="right" valign="top">final void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#a6920b2f0e9a84e290c16acac2f86ae93">navigationEvent</a> (EventName event)</td></tr>
<tr class="separator:a6920b2f0e9a84e290c16acac2f86ae93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17039d639541a43a786cd5057f9f27ae"><td class="memItemLeft" align="right" valign="top">final void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#a17039d639541a43a786cd5057f9f27ae">showAlternativeRoutesSucceeded</a> (String payload)</td></tr>
<tr class="separator:a17039d639541a43a786cd5057f9f27ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html">Navigation</a> should be extended to handle navigation directives from the Engine. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab8bfcea62eb634ece636a1264b5b5a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8bfcea62eb634ece636a1264b5b5a89">&#9670;&nbsp;</a></span>cancelNavigation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean com.amazon.aace.navigation.Navigation.cancelNavigation </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the platform implementation to cancel navigation</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the platform implementation successfully handled the call, else <code>false</code> </dd></dl>

</div>
</div>
<a id="ab9c911a083f6b927749106f3e3763dde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c911a083f6b927749106f3e3763dde">&#9670;&nbsp;</a></span>getNavigationState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String com.amazon.aace.navigation.Navigation.getNavigationState </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieve the navigation state from the platform. NOTE: You may return an empty string to default the payload to NOT_NAVIGATING</p>
<dl class="section return"><dt>Returns</dt><dd>the current NavigationState JSON payload <div class="fragment"><div class="line">) </div><div class="line">&quot;state&quot;: &quot;{{STRING}}&quot;, //NAVIGATING or NOT_NAVIGATING</div><div class="line">&quot;waypoints&quot;: [</div><div class="line">  {</div><div class="line">      &quot;type&quot;: &quot;{{STRING}}&quot;, //Type of the waypoint - SOURCE, DESTINATION or INTERIM  </div><div class="line">      &quot;estimatedTimeOfArrival&quot;: {</div><div class="line">          &quot;ideal&quot;: {{STRING}}, //Expected clock time ETA based on the ideal conditions. ISO 8601 UTC format</div><div class="line">          &quot;predicted&quot;: {{STRING}} //predicted clock time ETA based on traffic conditions. ISO 8601 UTC format</div><div class="line">       },</div><div class="line">      &quot;address&quot;: &quot;{{STRING}}&quot;,</div><div class="line">      &quot;coordinate&quot;: [{{LATITUDE_DOUBLE}},{{LONGITUDE_DOUBLE}}],</div><div class="line">  },</div><div class="line">  {</div><div class="line">      &quot;type&quot;: &quot;{{STRING}}&quot;, //Type of the waypoint - SOURCE, DESTINATION or INTERIM</div><div class="line">      &quot;estimatedTimeOfArrival&quot;: {</div><div class="line">          &quot;ideal&quot;: {{STRING}}, //Expected clock time ETA based on the ideal conditions. ISO 8601 UTC format</div><div class="line">          &quot;predicted&quot;: {{STRING}} //predicted clock time ETA based on traffic conditions. ISO 8601 UTC format</div><div class="line">       },</div><div class="line">      &quot;address&quot;: &quot;{{STRING}}&quot;,</div><div class="line">      &quot;coordinate&quot;: [{{LATITUDE_DOUBLE}},{{LONGITUDE_DOUBLE}}],</div><div class="line">      &quot;poiOfInterest&quot;: {</div><div class="line">          &quot;id&quot;: &quot;{{STRING}}&quot;, //POI lookup Id vended from Alexa</div><div class="line">          &quot;name&quot;: &quot;{{STRING}}&quot;, // POI Name  </div><div class="line">          &quot;hoursOfOperation&quot;: [</div><div class="line">           {</div><div class="line">               &quot;dayOfWeek&quot;: &quot;{{STRING}}&quot;,</div><div class="line">               &quot;hours&quot;: [</div><div class="line">                {</div><div class="line">                   &quot;open&quot;: &quot;{{STRING}}&quot;, // ISO-8601 time with timezone format</div><div class="line">                   &quot;close&quot;: &quot;{{STRING}}&quot; // ISO-8601 time with timezone format</div><div class="line">                }</div><div class="line">              ],</div><div class="line">              &quot;type&quot;: &quot;{{STRING}}&quot; // Can be: OPEN_DURING_HOURS, OPEN_24_HOURS, etc.</div><div class="line">          }</div><div class="line">          ],</div><div class="line">          &quot;phoneNumber&quot;: &quot;{{STRING}}&quot;</div><div class="line">       }</div><div class="line">     </div><div class="line">  },</div><div class="line">  ...</div><div class="line">],</div><div class="line">&quot;shapes&quot;: [</div><div class="line">  [</div><div class="line">      {{LATITUDE_DOUBLE}},</div><div class="line">      {{LONGITUDE_DOUBLE}}</div><div class="line">  ],</div><div class="line">  ...</div><div class="line">]</div></div><!-- fragment --> <ul>
<li>state (required) : current navigation state </li>
<li>waypoints (required) : list of waypoints, which can be empty </li>
<li>shapes (required) : list of route shapes, which can be empty or limited to 100 entries </li>
</ul>
</dd></dl>

</div>
</div>
<a id="a93fd177c707c9075348883824c7dcc0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93fd177c707c9075348883824c7dcc0b">&#9670;&nbsp;</a></span>startNavigation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void com.amazon.aace.navigation.Navigation.startNavigation </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>payload</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the platform implementation to start the navigation</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">payload</td><td>JSON data containing the destination information <div class="fragment"><div class="line">)</div><div class="line">&quot;transportationMode&quot;:&quot;{{STRING}}&quot;,</div><div class="line">&quot;waypoints&quot;:[</div><div class="line">   {</div><div class="line">       &quot;type&quot;:&quot;{{STRING}}&quot;,</div><div class="line">       &quot;estimatedTimeOfArrival&quot;:{</div><div class="line">           &quot;ideal&quot;:&quot;{{STRING}}&quot;, //ISO-8601 time format</div><div class="line">           &quot;predicted&quot;:&quot;{{STRING}}&quot; //ISO-8601 time format</div><div class="line">       },</div><div class="line">       &quot;address&quot;: {</div><div class="line">           &quot;addressLine1&quot;: &quot;{{STRING}}&quot;, //Address line 1</div><div class="line">           &quot;addressLine2&quot;: &quot;{{STRING}}&quot;, //Address line 2</div><div class="line">           &quot;addressLine3&quot;: &quot;{{STRING}}&quot;, //Address line 3</div><div class="line">           &quot;city&quot;: &quot;{{STRING}}&quot;, //city</div><div class="line">           &quot;districtOrCounty&quot;: &quot;{{STRING}}&quot;, //district or county</div><div class="line">           &quot;stateOrRegion&quot;: &quot;{{STRING}}&quot;, // state or region</div><div class="line">           &quot;countryCode&quot;: &quot;{{STRING}}&quot;, //3 letter country code</div><div class="line">           &quot;postalCode&quot;: &quot;{{STRING}}&quot;, // postal code</div><div class="line">       },</div><div class="line">       &quot;coordinate&quot;:[</div><div class="line">           &quot;{{LATITUDE_DOUBLE}}&quot;,</div><div class="line">           &quot;{{LONGITUDE_DOUBLE}}&quot;</div><div class="line">       ],</div><div class="line">       &quot;name&quot;:&quot;{{STRING}}&quot;</div><div class="line">   },</div><div class="line">   {</div><div class="line">       &quot;type&quot;:&quot;{{STRING}}&quot;,</div><div class="line">       &quot;estimatedTimeOfArrival&quot;:{</div><div class="line">           &quot;ideal&quot;:&quot;{{STRING}}&quot;,</div><div class="line">           &quot;predicted&quot;:&quot;{{STRING}}&quot;</div><div class="line">       },</div><div class="line">       &quot;address&quot;:&quot;{{STRING}}&quot;,</div><div class="line">       &quot;coordinate&quot;:[</div><div class="line">           &quot;{{LATITUDE_DOUBLE}}&quot;,</div><div class="line">           &quot;{{LONGITUDE_DOUBLE}}&quot;</div><div class="line">       ],</div><div class="line">       &quot;name&quot;:&quot;{{STRING}}&quot;</div><div class="line">       &quot;poiOfInterest&quot;:{</div><div class="line">           &quot;id&quot;:&quot;{{STRING}}&quot;,</div><div class="line">           &quot;hoursOfOperation&quot;:[</div><div class="line">               {</div><div class="line">               &quot;dayOfWeek&quot;:&quot;{{STRING}}&quot;,</div><div class="line">               &quot;hours&quot;:[</div><div class="line">                   {</div><div class="line">                       &quot;open&quot;:&quot;{{STRING}}&quot;,</div><div class="line">                       &quot;close&quot;:&quot;{{STRING}}&quot;</div><div class="line">                   }</div><div class="line">               ],</div><div class="line">               &quot;type&quot;:&quot;{{STRING}}&quot;</div><div class="line">               }</div><div class="line">           ],</div><div class="line">           &quot;phoneNumber&quot;:&quot;{{STRING}}&quot;</div><div class="line">       }</div><div class="line">   }</div><div class="line">]</div></div><!-- fragment --> <ul>
<li>transportationMode (optional) : Indicates the means by which to navigate to the destination (Values: BIKING, DRIVING, TRANSIT, WALKING) </li>
<li>waypoints (required) : list of waypoints, which can be empty </li>
<li>waypoints.type (required) : String from Enum Type of the waypoint - SOURCE, DESTINATION or INTERIM </li>
<li>estimatedTimeOfArrival (optional) : Arrival time at the destination </li>
<li>estimatedTimeOfArrival.ideal (optional) : Expected arrival time to the destination without considering any other signals such as traffic, diversions etc </li>
<li>estimatedTimeOfArrival.predicted (required) : Predicted arrival time to the destination based on traffic etc. In the case of actual and current matching, only current ETA will be populated </li>
<li>address (optional) : Waypoint address </li>
<li>address.addressLine1 (optional) : address line 1 </li>
<li>address.addressLine2 (optional) : address line 2 </li>
<li>address.addressLine3 (optional) : address line 3 </li>
<li>address.city (optional) : city of destination address </li>
<li>address.stateOrRegion (optional) : city of destination address </li>
<li>address.countryCode (optional) : 3 letter country code in ISO 3166-1 alpha-3 format </li>
<li>address.districtOrCounty (optional) : district or county </li>
<li>address.postalCode (optional) : postal code </li>
<li>coordinate (required) : Contains the geolocation information of the destination </li>
<li>coordinate.latitudeInDegrees (required) : Latitude coordinate in degrees </li>
<li>coordinate.longitudeInDegrees (required) : Longitute coordinate in degrees </li>
<li>name (optional) : waypoint name </li>
<li>pointOfInterest (optional) : POI information related to the waypoint </li>
<li>pointOfInterest.id (optional) : Lookup Id for the POIs vended by Alexa </li>
<li>metadata.hoursOfOperation (optional) : Hours of operation for the business </li>
<li>hoursOfOperation.dayOfWeek (required) : Day of the week (Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY) </li>
<li>hoursOfOperation.hours (required): List of opening (open) and closing (close) hours for the day. Hours are in ISO-8601 time with timezone format </li>
<li>hoursOfOperation.type (required) : Indicates whether the location is open on this day or not (Values: OPEN_DURING_HOURS, OPEN_24_HOURS, CLOSED, UNKNOWN, HOLIDAY) </li>
<li>metadata.phoneNumber (optional) : The phone number of the location in E.164 format </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa9c67468d2301d910b4ae765f60f34d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9c67468d2301d910b4ae765f60f34d5">&#9670;&nbsp;</a></span>announceManeuver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void com.amazon.aace.navigation.Navigation.announceManeuver </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>payload</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the platform implementation to give details about a maneuver to next waypoint on the route or a completely different waypoint off route.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">payload</td><td>JSON data containing the manueuver information <div class="fragment"><div class="line">)</div><div class="line">&quot;maneuverType&quot;: &quot;{{STRING}}&quot;, // requested maneuver type</div><div class="line">&quot;queryTarget&quot; : {</div><div class="line">    &quot;name&quot;: &quot;{{STRING}}&quot; // name of the requested location</div><div class="line">    &quot;address&quot;: { // address of requested location</div><div class="line">        &quot;addressLine1&quot;: &quot;{{STRING}}&quot;, //Address line 1</div><div class="line">        &quot;addressLine2&quot;: &quot;{{STRING}}&quot;, //Address line 2</div><div class="line">        &quot;addressLine3&quot;: &quot;{{STRING}}&quot;, //Address line 3</div><div class="line">        &quot;city&quot;: &quot;{{STRING}}&quot;, //city</div><div class="line">        &quot;districtOrCounty&quot;: &quot;{{STRING}}&quot;, //district or county</div><div class="line">        &quot;stateOrRegion&quot;: &quot;{{STRING}}&quot;, // state or region</div><div class="line">        &quot;countryCode&quot;: &quot;{{STRING}}&quot;, //3 letter country code</div><div class="line">        &quot;postalCode&quot;: &quot;{{STRING}}&quot;, // postal code</div><div class="line">    },</div><div class="line">    &quot;coordinate&quot;: [{{LATITUDE_DOUBLE}},{{LONGITUDE_DOUBLE}}]</div><div class="line"> }</div></div><!-- fragment --> <ul>
<li>maneuverType (required) : Can take values : TURN, EXIT, ENTER, MERGE, LANE </li>
<li>queryTarget (optional) : Contains information about the targeted location on the route. If the location is a POI / user place / street address, Alexa will resolve and provide all 3 fields in the directive. If Alexa is not able to resolve the target, then at least one of the three fields will be present if a target was specified. </li>
<li>queryTarget.name (optional) : name of the requested location </li>
<li>queryTarget.coordinate (optional) : The geographic coordinates (lat, long) of the location as an ordered double list. (The order of the lat/long double list → [Latitude double , Longitude double]) </li>
<li>queryTarget.address (optional) : Address of the requested location </li>
<li>queryTarget.address.addressLine1 (optional) : address line 1 </li>
<li>queryTarget.address.addressLine2 (optional) : address line 2 </li>
<li>queryTarget.address.addressLine3 (optional) : address line 3 </li>
<li>queryTarget.address.city (optional) : city of destination address </li>
<li>queryTarget.address.stateOrRegion (optional) : city of destination address </li>
<li>queryTarget.address.countryCode (optional) : 3 letter country code in ISO 3166-1 alpha-3 format </li>
<li>queryTarget.address.districtOrCounty (optional) : district or county </li>
<li>queryTarget.address.postalCode (optional) : postal code </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aee853c3f66d8205e733fb27644b829f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee853c3f66d8205e733fb27644b829f1">&#9670;&nbsp;</a></span>announceRoadRegulation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void com.amazon.aace.navigation.Navigation.announceRoadRegulation </td>
          <td>(</td>
          <td class="paramtype">RoadRegulation&#160;</td>
          <td class="paramname"><em>roadRegulation</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the platform implementation to give details about road regulations about the road segments that the user is on</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">roadRegulation</td><td>Type of road regulation requested.(Values: SPEED_LIMIT, CARPOOL_RULES) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af554852edcf3c872474896fef22a6403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af554852edcf3c872474896fef22a6403">&#9670;&nbsp;</a></span>navigationError()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">final void com.amazon.aace.navigation.Navigation.navigationError </td>
          <td>(</td>
          <td class="paramtype">ErrorType&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ErrorCode&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>description</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of error in handling a <a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html">Navigation</a> directive.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">type</td><td>ErrorType describing which operation failed. <ul>
<li>ErrorType values based on directive: </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#a93fd177c707c9075348883824c7dcc0b">startNavigation()</a>: NAVIGATION_START_FAILED </li>
<li>showPreviousWaypoints(): SHOW_PREVIOUS_WAYPOINTS_FAILED </li>
<li>navigateToPreviousWaypoint(): PREVIOUS_NAVIGATION_START_FAILED </li>
<li>controlDisplay(): ROUTE_OVERVIEW_FAILED, DIRECTIONS_LIST_FAILED, ZOOM_IN_FAILED, ZOOM_OUT_FAILED, CENTER_FAILED, ORIENT_NORTH_FAILED, SCROLL_NORTH_FAILED, SCROLL_UP_FAILED, SCROLL_EAST_FAILED, SCROLL_RIGHT_FAILED, SCROLL_SOUTH_FAILED, SCROLL_DOWN_FAILED, SCROLL_WEST_FAILED, SCROLL_LEFT_FAILED, MUTED_ROUTE_GUIDANCE_FAILED, UNMUTED_ROUTE_GUIDANCE_FAILED </li>
<li>showAlternativeRoutes(): DEFAULT_ALTERNATE_ROUTES_FAILED, SHORTER_TIME_ROUTES_FAILED, SHORTER_DISTANCE_ROUTES_FAILED, </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aa9c67468d2301d910b4ae765f60f34d5">announceManeuver()</a>: TURN_GUIDANCE_FAILED, EXIT_GUIDANCE_FAILED, ENTER_GUIDANCE_FAILED, MERGE_GUIDANCE_FAILED, LANE_GUIDANCE_FAILED, </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aee853c3f66d8205e733fb27644b829f1">announceRoadRegulation()</a>: SPEED_LIMIT_REGULATION_FAILED, CARPOOL_RULES_REGULATION_FAILED </li>
</ul>
</td></tr>
    <tr><td class="paramname">code</td><td>ErrorCode describing the type of failure. (Values: INTERNAL_SERVICE_ERROR, ROUTE_NOT_FOUND, NO_PREVIOUS_WAYPOINTS, NOT_SUPPORTED, NOT_ALLOWED) </td></tr>
    <tr><td class="paramname">description</td><td>String providing additional information. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a6920b2f0e9a84e290c16acac2f86ae93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6920b2f0e9a84e290c16acac2f86ae93">&#9670;&nbsp;</a></span>navigationEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">final void com.amazon.aace.navigation.Navigation.navigationEvent </td>
          <td>(</td>
          <td class="paramtype">EventName&#160;</td>
          <td class="paramname"><em>event</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of successful handling of a <a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html">Navigation</a> directive.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>EventName describing which operation was successful. <ul>
<li>EventName values based on directive: </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#a93fd177c707c9075348883824c7dcc0b">startNavigation()</a>: NAVIGATION_STARTED </li>
<li>showPreviousWaypoints(): PREVIOUS_WAYPOINTS_SHOWN </li>
<li>navigateToPreviousWaypoint(): PREVIOUS_NAVIGATION_STARTED </li>
<li>controlDisplay(): ROUTE_OVERVIEW_SHOWN, DIRECTIONS_LIST_SHOWN, ZOOMED_IN, ZOOMED_OUT, MAP_CENTERED, ORIENTED_NORTH, SCROLLED_NORTH, SCROLLED_UP, SCROLLED_EAST, SCROLLED_RIGHT, SCROLLED_SOUTH, SCROLLED_DOWN, SCROLLED_WEST, SCROLLED_LEFT, ROUTE_GUIDANCE_MUTED, ROUTE_GUIDANCE_UNMUTED </li>
<li>showAlternativeRoutes(): DEFAULT_ALTERNATE_ROUTES_SHOWN, SHORTER_TIME_ROUTES_SHOWN, SHORTER_DISTANCE_ROUTES_SHOWN </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aa9c67468d2301d910b4ae765f60f34d5">announceManeuver()</a>: TURN_GUIDANCE_ANNOUNCED, EXIT_GUIDANCE_ANNOUNCED, ENTER_GUIDANCE_ANNOUNCED, MERGE_GUIDANCE_ANNOUNCED, LANE_GUIDANCE_ANNOUNCED </li>
<li><a class="el" href="classcom_1_1amazon_1_1aace_1_1navigation_1_1_navigation.html#aee853c3f66d8205e733fb27644b829f1">announceRoadRegulation()</a>: SPEED_LIMIT_REGULATION_ANNOUNCED, CARPOOL_RULES_REGULATION_ANNOUNCED </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a17039d639541a43a786cd5057f9f27ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17039d639541a43a786cd5057f9f27ae">&#9670;&nbsp;</a></span>showAlternativeRoutesSucceeded()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">final void com.amazon.aace.navigation.Navigation.showAlternativeRoutesSucceeded </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>payload</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies AVS of successful showing of alternative routes to the user</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">payload</td><td>JSON data containing the alternative route information <div class="fragment"><div class="line">)</div><div class="line">&quot;inquiryType&quot;: &quot;{{STRING}}&quot; // DEFAULT, SHORTER_TIME, SHORTER_DISTANCE</div><div class="line">&quot;alternateRoute&quot;:</div><div class="line">  {</div><div class="line">      &quot;labels&quot;: [&quot;{{STRING}}&quot;],</div><div class="line">      &quot;savings&quot;: [</div><div class="line">          {</div><div class="line">              &quot;type&quot;: &quot;{{STRING}}&quot;, // DISTANCE, TIME</div><div class="line">              &quot;amount&quot;: &quot;{{FLOAT}}&quot;,</div><div class="line">              &quot;unit&quot;: &quot;{{STRING}}&quot; // MINUTE, HOUR, YARD, FOOT, MILE, METER, KILOMETER</div><div class="line">          }</div><div class="line">      ]              </div><div class="line">  }</div></div><!-- fragment --> <ul>
<li>inquiryType (required) : alternate route preference </li>
<li>alternateRoute (required) : The best route found that matches inquiryType. </li>
<li>labels (required) : Unique names within a route used to distinguish between alternative routes. The label might contain the direction of the route when passing by the detail. </li>
<li>savings (optional) : List of savings achieved by the route. Savings can be in: Time and/or Distance </li>
<li>savings.type (required) : The type of savings </li>
<li>savings.amount (required) : The amount of savings achieved by the route. Alexa will use prescribed unit to convert the amount of savings to improve the driver's experience, if needed. </li>
<li>savings.unit (required) : Measurement unit of the savings </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<html>
  <body>
    <hr style="height:1px;border-width:0;color:gray;background-color:gray">
    <p style="text-align:left;">
      Alexa Auto SDK 2.2.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
      <span style="float:right;">
        Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
      </span>
    </p>
  </body>
</html>
